refactor(core): bump messageformat parser. Add TS types #1328

timofei-iatsenko · 2023-01-09T09:50:53Z

Bumped version of the upstream messageformat parser to 5.0, updated what's broke and add TS typings wherever possible in touched files.

Resolves
#1278
#1303

Should be no changes in logic, but public types slightly changed. They became more accurate, so it's better to bump a version just in case.

How current config of semver works, should i name a PR with special prefix or commit message or it's doing manually?

Resolves lingui#1278

vercel · 2023-01-09T09:50:57Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
js-lingui	✅ Ready (Inspect)	Visit Preview	Jan 11, 2023 at 8:47AM (UTC)

andrii-bodnar · 2023-01-09T09:58:38Z

@thekip thanks for the contribution!

Probably, I'll ask @Martin005 to review this PR.

How current config of semver works, should i name a PR with special prefix or commit message or it's doing manually?

It expects that the PR title will be specified according to the following format:

https://github.com/amannn/action-semantic-pull-request#validation

Martin005 · 2023-01-10T11:12:23Z

@thekip You made changes only to the @lingui/core package.
Could you please also update the @lingui/cli and @lingui/remote-loader? They currently also use the messageformat-parser package.

Furthermore, updating the package may also fix issues #1033 and #1075 🙂

…bump message-parser

github-actions · 2023-01-10T13:18:57Z

size-limit report 📦

Path	Size
./packages/core/build/cjs/core.production.min.js	2.9 KB (0%)
./packages/detect-locale/build/cjs/detect-locale.production.min.js	798 B (0%)
./packages/react/build/cjs/react.production.min.js	4.91 KB (0%)
./packages/remote-loader/build/cjs/remote-loader.production.min.js	92.08 KB (0%)

timofei-iatsenko · 2023-01-10T13:26:19Z

My bad, didn't check this.

This commit is bigger, few things about what changed:

I've found a code duplication (3 times) where tokens from message-parser were converted to Lingui internal format.
I removed this code duplication by exporting from @lingui/core a parseMessage function and reusing it in all subpackages.
I simplified the way how the compiled catalogs produced. This was for 3 purposes:
1. to reuse mentioned function
2. to make code much cleaner and smaller
3. to make reading of catalogs actually faster than before.

Before compiled catalogs were produced as js template literal (js code) and complicated AST manipulation was involved

export const messages = {
  messageId: "message value"
}

Now i'm just using JSON.stringify / JSON.parse

export const messages = JSON.parse("{
 "messageId": "message value"
}")

Why it's better you can read here https://v8.dev/blog/cost-of-javascript-2019#json

Martin005

Thank you for the changes, I think that all of what you mentioned makes perfect sense including the JSON.stringify/JSON.parse! 🙂

When I tried your branch as a local package, I immediately noticed one mistake, so please have a look at my comments and resolve them.

When I resolved the mistake locally, I also tried all 4 issues #1033, #1075, #1278 and #1303 and I can confirm that all of them are fixed with this new version of @messageformat/parser package 🥳

Martin005 · 2023-01-10T15:30:49Z

packages/remote-loader/src/index.ts

@@ -28,6 +28,7 @@ function remoteLoader<T>({ format = "minimal", fallbackMessages, messages}: Remo
      `)
  }

+  // todo: that will not work with context


Remove this todo

This todo is here because the code in codebase already not working with context and changing this package was out of scope of that PR.

packages/core/src/i18n.ts

timofei-iatsenko · 2023-01-11T08:18:36Z

Fixed

timofei-iatsenko · 2023-01-11T08:31:32Z

I also thinking on how to hide exposed but treated as internal APIs, for example that formatMessage is supposed to be internal api, but because we use it in other packages it should be exported.

There should be either special naming convention, or may be just JSdoc would be enough

timofei-iatsenko · 2023-01-11T08:32:59Z

I see tests are failing, i will have a look

timofei-iatsenko · 2023-01-11T08:50:44Z

I've ported some changes from this PR #1328

I deleted pure option from createCompiledCatalog because it's not used anywhere in the project. This API considered internal, so we should be on the safe side.
It's probably was created for remote-loader but code has been changed since then and now this option is obsolete.

And also i've ported tests, because previous ones didn't test anything (there was a logical issue)

Martin005

Great, thank you for the changes!

refactor(core) bump messageformat parser. Add TS types

88ac94a

Resolves lingui#1278

timofei-iatsenko requested a review from andrii-bodnar January 9, 2023 09:50

vercel bot deployed to Preview January 9, 2023 09:52 View deployment

This was linked to issues Jan 9, 2023

i18n._ function removes unrecognized macros #1278

Closed

Bug: brackets in template literal results in macro compile failure #1303

Closed

andrii-bodnar requested a review from Martin005 January 9, 2023 09:59

This was linked to issues Jan 9, 2023

if the message has curly brackets in itself, compilation is broken #1075

Closed

Vietnamese support | bug #1033

Closed

refactor() generate JSON compiled catalogs, remove code duplication, …

f5e1528

…bump message-parser

timofei-iatsenko mentioned this pull request Jan 10, 2023

feat: add plural rule into compiled catalogs #1311

Closed

Martin005 changed the title ~~refactor(core) bump messageformat parser. Add TS types~~ refactor(core): bump messageformat parser. Add TS types Jan 10, 2023

Martin005 suggested changes Jan 10, 2023

View reviewed changes

refactor() fix plural typings

ced5eb8

timofei-iatsenko requested review from Martin005 and removed request for andrii-bodnar January 11, 2023 08:18

vercel bot deployed to Preview January 11, 2023 08:19 View deployment

refactor() remove outdated {pure} option and update tests

f156c65

vercel bot deployed to Preview January 11, 2023 08:47 View deployment

Martin005 approved these changes Jan 11, 2023

View reviewed changes

andrii-bodnar merged commit 5aa65d4 into lingui:main Jan 11, 2023

timofei-iatsenko deleted the fix/bump-messageformat-parser branch January 11, 2023 12:29

andrii-bodnar mentioned this pull request Jan 13, 2023

refactor(build): typescript + support inner exports #1336

Merged

timofei-iatsenko mentioned this pull request Jan 17, 2023

Migrate messageformat-parser to new AST @messageformat/parser #1034

Closed

Martin005 linked an issue Jan 17, 2023 that may be closed by this pull request

Migrate messageformat-parser to new AST @messageformat/parser #1034

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(core): bump messageformat parser. Add TS types #1328

refactor(core): bump messageformat parser. Add TS types #1328

timofei-iatsenko commented Jan 9, 2023 •

edited

Loading

vercel bot commented Jan 9, 2023 •

edited

Loading

andrii-bodnar commented Jan 9, 2023

Martin005 commented Jan 10, 2023 •

edited

Loading

github-actions bot commented Jan 10, 2023 •

edited

Loading

timofei-iatsenko commented Jan 10, 2023

Martin005 left a comment

Martin005 Jan 10, 2023

timofei-iatsenko Jan 11, 2023

timofei-iatsenko commented Jan 11, 2023

timofei-iatsenko commented Jan 11, 2023

timofei-iatsenko commented Jan 11, 2023

timofei-iatsenko commented Jan 11, 2023

Martin005 left a comment

refactor(core): bump messageformat parser. Add TS types #1328

refactor(core): bump messageformat parser. Add TS types #1328

Conversation

timofei-iatsenko commented Jan 9, 2023 • edited Loading

vercel bot commented Jan 9, 2023 • edited Loading

andrii-bodnar commented Jan 9, 2023

Martin005 commented Jan 10, 2023 • edited Loading

github-actions bot commented Jan 10, 2023 • edited Loading

size-limit report 📦

timofei-iatsenko commented Jan 10, 2023

Martin005 left a comment

Choose a reason for hiding this comment

Martin005 Jan 10, 2023

Choose a reason for hiding this comment

timofei-iatsenko Jan 11, 2023

Choose a reason for hiding this comment

timofei-iatsenko commented Jan 11, 2023

timofei-iatsenko commented Jan 11, 2023

timofei-iatsenko commented Jan 11, 2023

timofei-iatsenko commented Jan 11, 2023

Martin005 left a comment

Choose a reason for hiding this comment

timofei-iatsenko commented Jan 9, 2023 •

edited

Loading

vercel bot commented Jan 9, 2023 •

edited

Loading

Martin005 commented Jan 10, 2023 •

edited

Loading

github-actions bot commented Jan 10, 2023 •

edited

Loading